Skip to main content

Parametros Especiales

Parametros Especiales

Algunos parametros dependen del tipo de plan y otros afectan el desempeno o tiempo de renderizado del pdf Puedes jugar en conjunto con estos parametros para optimizar el resultado segun tus necesidades, por ejemplo: si tu pagina es una SPA puedes usar delay o wait_for_network para asegurarte de que se renderice correctamente, o si tu pdf es muy pesado puedes usar timeout para evitar que la tarea se quede colgada.

timeout -- number

Tiempo máximo (en segundos) que la API esperará a que una tarea se complete antes de cancelarla.
Si la operación excede este tiempo, la solicitud será terminada automáticamente ,
se devolverá lo que se haya generado hasta ese momento (soft timeout).
Por lo regular no es necesario especificarlo, 
pero puede ser util para tareas complejas o con mucho contenido.
info

Según el plan: Free 30s, Basic 60s, Plus 120s

delay -- number

Demora adicional en ms después de cargar la página (0 - 10000).  
info

Util para SPA o páginas con animaciones.

wait_for_network -- boolean

Esperar a que se complete la carga de todos los recursos de la página (imágenes, scripts, etc.)
antes de renderizar el PDF.Default: true

enableScroll -- boolean

Habilita scroll automático para cargar contenido lazy-loaded. Default: falses
Si se activa, en caso de no especificar tiempo maximo se hara scroll por el 70 % del tiempo maximo del Plan
Si ya no detecta cambios en la pagina se detendra el scroll aunque no se haya alcanzado el tiempo maximo,
Esto para optimizar el tiempo de renderizado y evitar scroll innecesarios.
Debe estar activo para usar los siguientes parametros (dependen del scroll para funcionar)
info

El 70% del timeout del plan, por ejemplo: 21s para free, 42s para basic y 84s para plus

warning

Si se utiliza con una url,puede causar efectos secundarios como cambios en el diseño o contenido del pdf generado, esto se debe a que al hacer scroll se pueden activar scripts o cargar recursos adicionales que afectan el resultado final.

maxScrollTime -- number

Tiempo máximo de scroll en segundos (1 - 70% del timeout).
info

Requiere que enableScroll esté activo.

scrollDelay -- number

Pausa entre cada scroll en ms (10-5000ms). Default: 100.
info

Requiere que enableScroll esté activo.

scrollStep -- number

Píxeles a avanzar por scroll (50 - 5000) Default: 200.
info

Requiere que enableScroll esté activo.